<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: log/verbosity_config.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_9381a7bbd03577d6d8720c7f35c94ffa.html">log</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">verbosity_config.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="verbosity__config_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="verbosity__config__fwd_8hpp.html">flow/log/verbosity_config_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="config_8hpp.html">flow/log/config.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1log.html">flow::log</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"></span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">/**</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * Optional-use structure encapsulating a full set of verbosity config, such that one can parse it from a config source</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * (like an options file) in concise form and apply it to a log::Config object.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> *</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * Put simply, one can read a string like `&quot;ALL:2;COOL_COMPONENT:4;ANOTHER_COMPONENT:TRACE&quot;` from an `istream` via</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * `&gt;&gt;`; then `this-&gt;apply_to_config(&amp;cfg)`, where `cfg` is a `log::Config`; resulting in the necessary</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * `Config::configure_default_verbosity()` and `Config::configure_component_verbosity_by_name()` calls that will set</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * the default verbosity to INFO and those specific components&#39; verbosities to DATA and TRACE respectively in order.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> */</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Verbosity__config.html">   41</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1log_1_1Verbosity__config.html">Verbosity_config</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"></span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment">  /// Short-hand for the configuration capable of being encapsulated by Verbosity_config.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Verbosity__config.html#ad90642c12d92b59954114a06c22217da">   47</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1log_1_1Verbosity__config.html#ad90642c12d92b59954114a06c22217da">Component_sev_pair_seq</a> = std::vector&lt;std::pair&lt;std::string, Sev&gt;&gt;;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"></span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">  /// String that Verbosity_config::parse() treats as the default/catch-all verbosity&#39;s &quot;component&quot; specifier.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Verbosity__config.html#a989cce681e783648d2efe1267d473406">   52</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> std::string <a class="code hl_variable" href="classflow_1_1log_1_1Verbosity__config.html#a989cce681e783648d2efe1267d473406">S_ALL_COMPONENT_NAME_ALIAS</a>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"></span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">  /// Separates component/severity pairs in a Verbosity_config specifier string.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Verbosity__config.html#a8dba58a66513ec3f58a17660af54a639">   55</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> <a class="code hl_variable" href="classflow_1_1log_1_1Verbosity__config.html#a8dba58a66513ec3f58a17660af54a639">S_TOKEN_SEPARATOR</a>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"></span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment">  /// Separates component and severity within each pair in a Verbosity_config specifier string.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Verbosity__config.html#afe80e0c5e2d23faafa1646022b7074e4">   58</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> <a class="code hl_variable" href="classflow_1_1log_1_1Verbosity__config.html#afe80e0c5e2d23faafa1646022b7074e4">S_PAIR_SEPARATOR</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"></span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">   * Constructor a Verbosity_config that resets all severity config and sets the default/catch-all to</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">   * Config::S_MOST_VERBOSE_SEV_DEFAULT.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">   */</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>  <a class="code hl_function" href="classflow_1_1log_1_1Verbosity__config.html#ab5490488a1341ea880094729df8ba4b7">Verbosity_config</a>();</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"></span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   * Deserializes `*this` from a standard input stream.  Reads a single space-delimited token</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   * from the given stream.  Separates that into a sequence of #S_TOKEN_SEPARATOR-delimited pairs, each representing an</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   * element of what will be returnable via component_sev_pairs(), in order.  Each pair is to be in one of</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   * the following forms:</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   *   - No #S_PAIR_SEPARATOR; just a Severity readable via its `istream&lt;&lt;` operator (as of this writing,</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   *     a number &quot;1&quot;, &quot;2&quot;, ... or a string &quot;WARNING&quot;, &quot;INFO&quot;, etc.).  Then this is taken to be the severity, and</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   *     the component name for component_sev_pairs() is taken to be as-if &quot;&quot; (the default).</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">   *   - &quot;:sev&quot; (where the colon stands for #S_PAIR_SEPARATOR): As-if simply &quot;sev&quot; (previous bullet point).</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">   *   - &quot;ALL:sev&quot; (ditto re. colon): `ALL` is #S_ALL_COMPONENT_NAME_ALIAS: Same meaning as previous bullet point.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   *   - &quot;name:sev&quot; (ditto re. colon): `name` is the component name; `sev` is the Severity readable via its</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   *     `istream&lt;&lt;` operator.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   *</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   * Returns `true` if the token was legal; else `false`.  last_result_message() can then be invoked to get</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   * further details suitable for display to the user in the case of `false`.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   *</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   * If `true` returned, the existing payload is completely overwritten.  Otherwise it is untouched.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   *</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   * @param is</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   *        Input stream.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   * @return `true` if and only if successfully deserialized.  See also last_result_message().</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   */</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1log_1_1Verbosity__config.html#afaf5a5fb1d9e56946403072eadaa3c10">parse</a>(std::istream&amp; is);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"></span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   * Applies `*this` to to the given log::Config.  Typically one would parse into `*this` first.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   *</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   * Returns `true` if this succeeded; else `false`.  last_result_message() can then be invoked to get</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   * further details suitable for display to the user in the case of `false`.  Typically this would only occur, as of</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   * this writing, on an unknown component name according to what has been registered on `*target_config`.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   *</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   * If `true` returned, the Config verbosity config is completely overwritten; otherwise it is reset and completely</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   * overwritten but may represent only a partial application (valid but typically not advisable to use).</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   *</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   * @param target_config</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   *        The log::Config to reset.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   * @return `true` if and only if successfully applied.  See also last_result_message().</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   */</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1log_1_1Verbosity__config.html#a3a64ac2ee6eaf09fc9de6199916d0388">apply_to_config</a>(<a class="code hl_class" href="classflow_1_1log_1_1Config.html">Config</a>* target_config);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"></span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">   * To be used after parse() or `operator&lt;&lt;` or apply_to_config(), returns &quot;&quot; on success or a message describing</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">   * the problem on failure.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   *</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   */</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>  <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classflow_1_1log_1_1Verbosity__config.html#a02443dac5b22a39d2be192229700f265">last_result_message</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"></span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">   * Read-only access to encapsulated config; specifies the verbosity-setting calls to make on a Config in order,</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">   * given as component-name-to-severity pairs, with an empty component name specifying the default severity used</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   * when no component name is given.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   *</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   * The assumed semantics as applied to a given log::Config `cfg` are as follows:</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   *   -# If empty, or the first pair&#39;s component name is *not* &quot;&quot;, then act as-if there was an additional</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   *      front-inserted pair `(&quot;&quot;, Config::S_MOST_VERBOSE_SEV_DEFAULT)`.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   *   -# For the first pair: `cfg.configure_default_verbosity(v, true);`, where `v` is the log::Sev in that slot.</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   *      In other words the config is reset, and the catch-all default verbosity is initialized to that severity.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   *   -# For each subsequent pair `(name, v)`:</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   *      - If the `name` is &quot;&quot;: `cfg.configure_default_verbosity(v, false);`.</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   *      - Otherwise: `cfg.configure_component_verbosity_by_name(v, name);`.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">   *</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">   */</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1log_1_1Verbosity__config.html#ad90642c12d92b59954114a06c22217da">Component_sev_pair_seq</a>&amp; <a class="code hl_function" href="classflow_1_1log_1_1Verbosity__config.html#ad71628d526e0933e83d26ef050fc9350">component_sev_pairs</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"></span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">  /// See component_sev_pairs().</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Verbosity__config.html#a7cd37a6ffaf0bbd8dd340ecc3a760375">  140</a></span><span class="comment"></span>  <a class="code hl_typedef" href="classflow_1_1log_1_1Verbosity__config.html#ad90642c12d92b59954114a06c22217da">Component_sev_pair_seq</a> <a class="code hl_variable" href="classflow_1_1log_1_1Verbosity__config.html#a7cd37a6ffaf0bbd8dd340ecc3a760375">m_component_sev_pairs</a>;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"></span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment">  /// See last_result_message().</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="classflow_1_1log_1_1Verbosity__config.html#a631fc8482ff3a4c95321143dbebd9d3f">  143</a></span><span class="comment"></span>  std::string <a class="code hl_variable" href="classflow_1_1log_1_1Verbosity__config.html#a631fc8482ff3a4c95321143dbebd9d3f">m_last_result_message</a>;</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>}; <span class="comment">// struct Verbosity_config</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span> </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>} <span class="comment">// namespace flow::log</span></div>
<div class="ttc" id="aclassflow_1_1log_1_1Config_html"><div class="ttname"><a href="classflow_1_1log_1_1Config.html">flow::log::Config</a></div><div class="ttdoc">Class used to configure the filtering and logging behavior of Loggers; its use in your custom Loggers...</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00316">config.hpp:317</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html">flow::log::Verbosity_config</a></div><div class="ttdoc">Optional-use structure encapsulating a full set of verbosity config, such that one can parse it from ...</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8hpp_source.html#l00041">verbosity_config.hpp:42</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_a02443dac5b22a39d2be192229700f265"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#a02443dac5b22a39d2be192229700f265">flow::log::Verbosity_config::last_result_message</a></div><div class="ttdeci">const std::string &amp; last_result_message() const</div><div class="ttdoc">To be used after parse() or operator&lt;&lt; or apply_to_config(), returns &quot;&quot; on success or a message descr...</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8cpp_source.html#l00194">verbosity_config.cpp:194</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_a3a64ac2ee6eaf09fc9de6199916d0388"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#a3a64ac2ee6eaf09fc9de6199916d0388">flow::log::Verbosity_config::apply_to_config</a></div><div class="ttdeci">bool apply_to_config(Config *target_config)</div><div class="ttdoc">Applies *this to to the given log::Config.</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8cpp_source.html#l00157">verbosity_config.cpp:157</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_a631fc8482ff3a4c95321143dbebd9d3f"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#a631fc8482ff3a4c95321143dbebd9d3f">flow::log::Verbosity_config::m_last_result_message</a></div><div class="ttdeci">std::string m_last_result_message</div><div class="ttdoc">See last_result_message().</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8hpp_source.html#l00143">verbosity_config.hpp:143</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_a7cd37a6ffaf0bbd8dd340ecc3a760375"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#a7cd37a6ffaf0bbd8dd340ecc3a760375">flow::log::Verbosity_config::m_component_sev_pairs</a></div><div class="ttdeci">Component_sev_pair_seq m_component_sev_pairs</div><div class="ttdoc">See component_sev_pairs().</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8hpp_source.html#l00140">verbosity_config.hpp:140</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_a8dba58a66513ec3f58a17660af54a639"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#a8dba58a66513ec3f58a17660af54a639">flow::log::Verbosity_config::S_TOKEN_SEPARATOR</a></div><div class="ttdeci">static const char S_TOKEN_SEPARATOR</div><div class="ttdoc">Separates component/severity pairs in a Verbosity_config specifier string.</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8hpp_source.html#l00055">verbosity_config.hpp:55</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_a989cce681e783648d2efe1267d473406"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#a989cce681e783648d2efe1267d473406">flow::log::Verbosity_config::S_ALL_COMPONENT_NAME_ALIAS</a></div><div class="ttdeci">static const std::string S_ALL_COMPONENT_NAME_ALIAS</div><div class="ttdoc">String that Verbosity_config::parse() treats as the default/catch-all verbosity's &quot;component&quot; specifi...</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8hpp_source.html#l00052">verbosity_config.hpp:52</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_ab5490488a1341ea880094729df8ba4b7"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#ab5490488a1341ea880094729df8ba4b7">flow::log::Verbosity_config::Verbosity_config</a></div><div class="ttdeci">Verbosity_config()</div><div class="ttdoc">Constructor a Verbosity_config that resets all severity config and sets the default/catch-all to Conf...</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8cpp_source.html#l00034">verbosity_config.cpp:34</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_ad71628d526e0933e83d26ef050fc9350"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#ad71628d526e0933e83d26ef050fc9350">flow::log::Verbosity_config::component_sev_pairs</a></div><div class="ttdeci">const Component_sev_pair_seq &amp; component_sev_pairs() const</div><div class="ttdoc">Read-only access to encapsulated config; specifies the verbosity-setting calls to make on a Config in...</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8cpp_source.html#l00199">verbosity_config.cpp:199</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_ad90642c12d92b59954114a06c22217da"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#ad90642c12d92b59954114a06c22217da">flow::log::Verbosity_config::Component_sev_pair_seq</a></div><div class="ttdeci">std::vector&lt; std::pair&lt; std::string, Sev &gt; &gt; Component_sev_pair_seq</div><div class="ttdoc">Short-hand for the configuration capable of being encapsulated by Verbosity_config.</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8hpp_source.html#l00047">verbosity_config.hpp:47</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_afaf5a5fb1d9e56946403072eadaa3c10"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#afaf5a5fb1d9e56946403072eadaa3c10">flow::log::Verbosity_config::parse</a></div><div class="ttdeci">bool parse(std::istream &amp;is)</div><div class="ttdoc">Deserializes *this from a standard input stream.</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8cpp_source.html#l00044">verbosity_config.cpp:44</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Verbosity__config_html_afe80e0c5e2d23faafa1646022b7074e4"><div class="ttname"><a href="classflow_1_1log_1_1Verbosity__config.html#afe80e0c5e2d23faafa1646022b7074e4">flow::log::Verbosity_config::S_PAIR_SEPARATOR</a></div><div class="ttdeci">static const char S_PAIR_SEPARATOR</div><div class="ttdoc">Separates component and severity within each pair in a Verbosity_config specifier string.</div><div class="ttdef"><b>Definition:</b> <a href="verbosity__config_8hpp_source.html#l00058">verbosity_config.hpp:58</a></div></div>
<div class="ttc" id="aconfig_8hpp_html"><div class="ttname"><a href="config_8hpp.html">config.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1log_html"><div class="ttname"><a href="namespaceflow_1_1log.html">flow::log</a></div><div class="ttdoc">Flow module providing logging functionality.</div><div class="ttdef"><b>Definition:</b> <a href="async__file__logger_8cpp_source.html#l00027">async_file_logger.cpp:28</a></div></div>
<div class="ttc" id="averbosity__config__fwd_8hpp_html"><div class="ttname"><a href="verbosity__config__fwd_8hpp.html">verbosity_config_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
